/*
 * JSF Toolkit Component Framework
 * Copyright (C) 2007 Noah Sloan <iamnoah A-T gmail D0T com>
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 */
package com.jsftoolkit.base;

import java.util.List;
import java.util.Map;

import javax.faces.component.UIComponent;
import javax.faces.component.UIData;

import com.jsftoolkit.base.components.UIDataProcessor;

/**
 * Interface for components that do iteration in JSF, but might not be able to
 * extend {@link UIData}. Each method is expected to do just what it would in
 * UIData. Iteration starts at the index returned by {@link #getFirst()} and
 * ends after {@link #getRows()} have been processed or
 * {@link #isRowAvailable()} returns false.
 * <p>
 * This interface may be used with {@link UIDataProcessor}.
 * 
 * @author noah
 * 
 */
public interface JsfIterator extends ChildManager {

	int getRowIndex();

	int getFirst();

	int getRows();

	void setRowIndex(int rowIndex);

	boolean isRowAvailable();

	Map<String, UIComponent> getFacets();

	List<UIComponent> getChildren();

}
